package com.bkhech.spring.security.example.accesstoken;

import com.bkhech.spring.security.example.accesstoken.oauth2.dto.OAuth2AccessTokenCheckRespDto;
import com.bkhech.spring.security.example.accesstoken.oauth2.dto.OAuth2AccessTokenCreateReqDto;
import com.bkhech.spring.security.example.accesstoken.oauth2.dto.OAuth2AccessTokenRespDto;

import javax.validation.Valid;

/**
 * Access Token API 接口
 *
 * @author guowm
 * @date 2023/2/1
 */
public interface AccessTokenApi {

    /**
     * 创建访问令牌
     *
     * @param reqDto 访问令牌的创建信息
     * @return 访问令牌信息
     */
    OAuth2AccessTokenRespDto createAccessToken(@Valid OAuth2AccessTokenCreateReqDto reqDto);

    /**
     * 移除访问令牌
     *
     * @param accessToken 访问令牌
     * @return 访问令牌信息
     */
    OAuth2AccessTokenRespDto removeAccessToken(String accessToken);

    /**
     * 刷新访问令牌
     * @param refreshToken 刷新令牌
     * @param clientId 客户端编号
     * @return 访问令牌信息
     */
    OAuth2AccessTokenRespDto refreshAccessToken(String refreshToken, String clientId);

    /**
     * 校验访问令牌
     * @param accessToken 访问令牌
     * @return 访问令牌的信息
     */
    OAuth2AccessTokenCheckRespDto checkAccessToken(String accessToken);

}
